home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Toolbox / Visual Basic Toolbox (P.I.E.)(1996).ISO / ocx / maze / defined.txt next >
Text File  |  1996-03-05  |  3KB  |  79 lines
  1. Maze.OCX - Copyright 1996 Caffeinated Software
  2. Version 1.00b
  3. 03/05/96
  4. ========================================================================
  5. Here's a short description of the constants, properties and methods
  6. that are used in the Maze.OCX.  You must declare the constants somewhere
  7. in your code in order to use them.  If you have any problems, please 
  8. feel free to e-mail me at kim@interport.net.
  9.  
  10.  
  11. Constants
  12. ------------------------------------------------------------------------
  13. const mazeTop = &H0001
  14. const mazeBottom = &H0002
  15. const mazeRight = &H0004
  16. const mazeLeft = &H0008
  17. const dirUp = 0
  18. const dirDown = 1
  19. const dirLeft = 2
  20. const dirRight = 3
  21.  
  22.  
  23. Properties
  24. ------------------------------------------------------------------------
  25. PlayerName
  26.   Text used to specify a player name
  27. MazeRows
  28.   Total number of rows in maze
  29. MazeCols
  30.   Total number of columns in maze
  31.  
  32.  
  33. Methods
  34. ------------------------------------------------------------------------
  35. NewPlayer()
  36.   Adds a new player to the control.  Uses PlayerName (if no player 
  37.   name specified, it will set it to "default").  Returns the player ID.
  38. RemovePlayer(ID as integer)
  39.   Removes the player specified by ID.  Returns true or false depending
  40.   upon success.
  41. DefineWall(Row as integer, Col as integer, mFlags as integer)
  42.   Defines a wall at the location specified by Row and Col.  mFlags is
  43.   a value represented by mazeTop, mazeBottom, mazeLeft, and mazeRight
  44.   constants.  For instance, if you want a wall on the top and the left
  45.   sides of the grid cell, you would use mFlags = mazeTop AND mazeLeft.
  46. GetWall(Row as integer, Col as integer)
  47.   Gets the value of the walls for the grid cell specified by Row and
  48.   Col.  For instance, for a top and bottom wall, the value would be 3
  49.   (mazeTop AND mazeBottom = 3).  To get individual values OR the result.
  50.   Example:  isTop = GetWall(0, 0) OR mazeTop
  51. PlayerMoveUp(ID as integer)
  52.   Moves the player (specified by ID) up a row in the maze.  If
  53.   successful, returns True.  If player can't move up due to wall or
  54.   edge, returns False.
  55. PlayerMoveDown, PlayerMoveLeft, PlayerMoveRight
  56.   Same as above
  57. PlayerMove(ID as integer, Direction as integer)
  58.   Moves the specified player in the specified direction one cell.
  59.   Direction is one of the 4 values described above.
  60. GetPlayerX(ID as integer)
  61.   Returns the specified player's X location in the grid.
  62. GetPlayerY(ID as integer)
  63.   Returns the specified player's Y location in the grid.
  64. SetPlayerScore(ID as integer, Score as integer)
  65.   Sets the specified player's score to the specified value.
  66. GetPlayerScore(ID as integer)
  67.   Returns the specified player's score.
  68. SetObstacle(Row as integer, Col as integer, Type as integer)
  69.   Sets an obstacle at the specified location in the grid.  Type
  70.   is the type of the obstacle.  It has no significance; it's merely
  71.   a data item for your use.
  72. GetObstacle(Row as integer, Col as integer)
  73.   Returns the type of obstacle at the given row and column.  Returns
  74.   -1 if there is no obstacle at that location.
  75.   Note:  A player can be at the same location as an obstacle.
  76. SetPlayerLocation(ID as integer, Row as integer, Col as integer)
  77.   Moves the specified player to the specified cell in the grid if
  78.   possible.  Returns True if successful, False if not.
  79.